//
// (C) Copyright 2009 Irantha Suwandarathna (irantha@gmail.com)
// All rights reserved.
//

/* Copyright (c) 2001-2008, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use _in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions _in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer _in the documentation
 * and/or other materials provided with the distribution.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


using System;
using EffiProz.Core.RowIO;
using EffiProz.Core.Indexes;
using EffiProz.Core.Navigators;


namespace EffiProz.Core.Persist
{

    /**
     * Interface for a store for CachedObject object.
     *
     * @author fredt@users
     * @version 1.8.0
     * @since 1.8.0
     */
    public static class PersistentStoreConstants
    {
        public const int INT_STORE_SIZE = 4;
        public const int LONG_STORE_SIZE = 8;
    }

    public interface PersistentStore
    {
        bool isMemory();

        int getAccessCount();

        void set(CachedObject _object);

        /** get object */
        CachedObject get(int key);

        /** get object with keep, ensuring future gets will return the same instance of the object */
        CachedObject get(int key, bool keep);

        CachedObject get(CachedObject _object, bool keep);

        int getStorageSize(int key);

        /** add new object */
        void add(CachedObject _object);        

        CachedObject get(RowInputInterface _in);

        CachedObject getNewInstance(int size);

        CachedObject getNewCachedObject(Session session, Object _object);

        /** remove the persisted image but not the cached copy */
        void removePersistence(int i);

        void removeAll();

        /** remove both persisted and cached copies */
        void remove(int i);

        /** remove the cached copies */
        void release();

        /** commit persisted image */
        void commitPersistence(CachedObject _object);

        void delete(Row row);

        void indexRow(Session session, Row row);

        void indexRows();

        RowIterator rowIterator();

         void release(int key);
       
        //
         DataFileCache getCache();

         void setCache(DataFileCache cache);

         PersistentStore getAccessorStore(Index index);

        CachedObject getAccessor(Index key);

        void setAccessor(Index key, CachedObject accessor);

        void setAccessor(Index key, int accessor);

        void resetAccessorKeys(Index[] keys);

        void lockStore();

        void unlockStore();

    }
}
